Microsoft Marketplace Catalog Browse API (stable:2021-10-01)

2025/12/05 • 2 new methods

PublicOffers_Get (new)
Description :  Get a public offer by id
Reference :  Link ¶

⚼ Request

GET:  /offers/{id}
{
id:
{
Description: Offer id ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
language:
{
Description: Offer language ,
Required: False ,
}
string ,
market:
{
Description: Offer market ,
Required: False ,
}
string ,
includeStopSoldPlans:
{
Description: To include stop sold or hidden plans ,
Required: False ,
}
boolean ,
hideKeys:
{
Description: Add hide key to retrieve preview items ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
language:
{
Description: Language ,
Required: True ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
hasStandardContractAmendments:
{
Description: A value indicating whether standard contract amendments are present for this product ,
Required: True ,
}
boolean ,
publisherMpnId:
{
Description: The publisher's Microsoft Partner Network (MPN) Id ,
Required: False ,
}
string ,
sellerId:
{
Description: Partner Center Seller Id ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
partnerCenterId:
{
Description: Partner center id ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
offerId:
{
Description: Offer id ,
Required: True ,
}
string ,
legacyId:
{
Description: Offer legacy id ,
Required: True ,
}
string ,
determinedStorefronts:
{
Description: The list of the storefronts for which this offer is designated ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: Summary ,
Required: False ,
}
string ,
longSummary:
{
Description: Long summary ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
offerType:
{
Description: Offer type ,
Required: True ,
}
string ,
isPrivate:
{
Description: A value indicating whether the item is private ,
Required: True ,
}
boolean ,
isPreview:
{
Description: A value indicating whether the item is preview ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether sale of this item is stopped ,
Required: True ,
}
boolean ,
fulfillBeforeChargeEligible:
{
Description: A value indicating whether this item is eligible for fulfill before charge ,
Required: True ,
}
boolean ,
marketingMaterial:
{
Description: Marketing material added by the publisher ,
Required: False ,
}
string ,
markets:
{
Description: Markets for the item ,
Required: False ,
}
[
string ,
]
,
isvContactDetails:
{
Description: ISV contact details ,
Required: False ,
}
object ,
bigId:
{
Description: Big catalog id ,
Required: True ,
}
string ,
ocpSolutionId:
{
Description: OCP solution id of the product ,
Required: False ,
}
string ,
legalTermsUri:
{
Description: Legal terms URI ,
Required: False ,
}
string ,
cspLegalTermsUri:
{
Description: CSP legal terms URI ,
Required: False ,
}
string ,
legalTermsType:
{
Description: Type of to the legal terms ,
Required: True ,
}
string ,
privacyPolicyUri:
{
Description: Uri to the privacy policy of the product ,
Required: False ,
}
string ,
helpLink:
{
Description: Help link for the product ,
Required: False ,
}
string ,
supportUri:
{
Description: Support uri of the product ,
Required: False ,
}
string ,
version:
{
Description: Big Cat submission version ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: User interface definition uri ,
Required: False ,
}
string ,
categoryIds:
{
Description: List of category IDs the marketplace item belongs to ,
Required: False ,
}
[
string ,
]
,
marketCode:
{
Description: Market code of a service offer ,
Required: False ,
}
string ,
marketStates:
{
Description: Market states of a service offer ,
Required: False ,
}
[
string ,
]
,
industryIds:
{
Description: List of industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
cloudIndustryCategories:
{
Description: List of cloud industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
primaryProduct:
{
Description: Primary product for the offer ,
Required: False ,
}
string ,
supportedProducts:
{
Description: It maps to the list of products the publisher provides with which their offer works ,
Required: False ,
}
[
string ,
]
,
applicableProducts:
{
Description: Product categories the offer belongs to ,
Required: False ,
}
[
string ,
]
,
serviceType:
{
Description: Service type that applies to the offer ,
Required: False ,
}
string ,
competencies:
{
Description: Competencies that apply to the offer ,
Required: False ,
}
[
{
competencyName:
{
Description: Competency name ,
Required: False ,
}
string ,
competencyLevel:
{
Description: Competency level ,
Required: False ,
}
string ,
}
,
]
,
hasPrices:
{
Description: A value indicating whether the item has prices ,
Required: False ,
}
boolean ,
duration:
{
Description: The duration that applies to the item ,
Required: False ,
}
string ,
marketPricingDetails:
{
Description: The pricing details of each market to the item ,
Required: False ,
}
[
{
pricing:
{
Description: Pricing that applies to the item ,
Required: False ,
}
string ,
marketCode:
{
Description: Market code of a service offer ,
Required: False ,
}
string ,
marketStates:
{
Description: Market states of a service offer ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
pricing:
{
Description: The pricing that applies to the item ,
Required: False ,
}
string ,
solutionAreas:
{
Description: The states that apply to the item ,
Required: False ,
}
[
string ,
]
,
screenshotUris:
{
Description: List of screenshot image URIs provided for the item ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: List of Links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: URI of the link ,
Required: False ,
}
string ,
}
,
]
,
filters:
{
Description: List of filters for the item ,
Required: False ,
}
[
{
type:
{
Description: Filter type ,
Required: False ,
}
string ,
value:
{
Description: Filter value ,
Required: False ,
}
string ,
}
,
]
,
iconFileUris:
{
Description: Dictionary of icon image URIs by icon type ,
Required: False ,
}
object ,
artifacts:
{
Description: List of artifacts ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
type:
{
Description: Artifact type ,
Required: True ,
}
string ,
}
,
]
,
metadata:
{
Description: Custom item metadata ,
Required: False ,
}
string ,
images:
{
Description: List of Images ,
Required: False ,
}
[
{
context:
{
Description: context ,
Required: False ,
}
string ,
items:
{
Description: List of images ,
Required: False ,
}
[
{
id:
{
Description: Image id ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
type:
{
Description: Image type ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
videos:
{
Description: List of product videos ,
Required: False ,
}
[
{
caption:
{
Description: Caption ,
Required: False ,
}
string ,
uri:
{
Description: Video uri ,
Format: uri ,
Required: False ,
}
string ,
videoPurpose:
{
Description: Video purpose ,
Required: False ,
}
string ,
previewImage:
{
Description: Preview image ,
Required: False ,
}
string ,
}
,
]
,
plans:
{
Description: Plans available for the offer details ,
Required: False ,
}
[
{
id:
{
Description: Plan id ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan ,
Required: False ,
}
string ,
summary:
{
Description: Summary of the plan ,
Required: False ,
}
string ,
description:
{
Description: Description of the plan ,
Required: False ,
}
string ,
restrictedAudience:
{
Description: Restricted audience ,
Required: False ,
}
string ,
skuId:
{
Description: Sku id ,
Required: False ,
}
string ,
planId:
{
Description: Plan id ,
Required: False ,
}
string ,
legacyPlanId:
{
Description: Legacy plan Id which is obtained by combining Offer->LegacyId and PlanId with no separator in between ,
Required: False ,
}
string ,
keywords:
{
Description: List of keywords ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Offer type ,
Required: True ,
}
string ,
leadGeneration:
{
Description: Lead generation info ,
Required: False ,
}
string ,
testDrive:
{
Description: Test Drive info ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities for this plan ,
Required: False ,
}
[
{
actions:
{
Description: List of allowed actions ,
Required: False ,
}
[
string ,
]
,
market:
{
Description: Market for the availability collection ,
Required: False ,
}
string ,
isPIRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
appId:
{
Description: App id of the availability collection ,
Required: False ,
}
string ,
planID:
{
Description: Plan Id of the availability collection ,
Required: False ,
}
string ,
meterId:
{
Description: Applicable billing meter Id ,
Required: False ,
}
string ,
meter:
{
Description: Applicable billing meter information ,
Required: False ,
}
string ,
pricingAudience:
{
Description: Pricing audience ,
Required: True ,
}
string ,
terms:
{
Description: List of applicable terms ,
Required: False ,
}
[
{
termDescriptionParameters:
{
Description: Term description parameters ,
Required: False ,
}
[
{
parameter:
{
Description: Parameter ,
Required: False ,
}
string ,
value:
{
Description: Value ,
Required: False ,
}
string ,
}
,
]
,
termId:
{
Description: Term id ,
Required: False ,
}
string ,
termUnits:
{
Description: Term unit ,
Required: False ,
}
string ,
prorationPolicy:
{
Description: Proration policy ,
Required: False ,
}
string ,
termDescription:
{
Description: Term description ,
Required: False ,
}
string ,
price:
{
Description: Price for the term ,
Required: False ,
}
string ,
renewTermId:
{
Description: Renew term id ,
Required: False ,
}
string ,
renewTermUnits:
{
Description: Renew term units ,
Required: False ,
}
string ,
billingPlan:
{
Description: Billing Plan ,
Required: False ,
}
string ,
}
,
]
,
piFilter:
{
Description: Applicable billing meter information ,
Required: False ,
}
string ,
isStopSell:
{
Description: A value indicating whether it has been stopped from sell in a market ,
Required: True ,
}
boolean ,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
assetBehaviors:
{
Description: Asset behaviors ,
Required: False ,
}
[
string ,
]
,
consumptionUnitType:
{
Description: Consumption unit type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Format: int32 ,
Required: True ,
}
integer ,
partitionKey:
{
Description: Partition key ,
Required: False ,
}
string ,
remediationRequired:
{
Description: A value indicating whether remediation is required to acquire availability ,
Required: True ,
}
boolean ,
remediations:
{
Description: Remediation actions for acquiring availability if RemediationRequired is true ,
Required: False ,
}
[
{
remediationId:
{
Description: Remediation identifier ,
Required: False ,
}
string ,
type:
{
Description: Remediation type ,
Required: False ,
}
string ,
}
,
]
,
startDate:
{
Description: Availability effectiveness start date - in epoch minutes ,
Format: int32 ,
Required: False ,
}
integer ,
endDate:
{
Description: Availability effectiveness end date - in epoch minutes ,
Format: int32 ,
Required: False ,
}
integer ,
planAvailabilities:
{
Description: Plan availabilities ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
categoryIds:
{
Description: Category IDs for this plan ,
Required: False ,
}
[
string ,
]
,
conversionPaths:
{
Description: Conversion paths for this plan ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata for this plan ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Operating system info for this plan ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: What blade to be opened when someone wants to create the marketplace item ,
Required: False ,
}
string ,
artifacts:
{
Description: Files related to the marketplace item ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
type:
{
Description: Artifact type ,
Required: True ,
}
string ,
}
,
]
,
version:
{
Description: Version of the marketplace item ,
Required: False ,
}
string ,
itemName:
{
Description: Item name ,
Required: False ,
}
string ,
isPrivate:
{
Description: A value indicating whether the item is private ,
Required: True ,
}
boolean ,
isHidden:
{
Description: A value indicating whether the plan is hidden ,
Required: True ,
}
boolean ,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
isByol:
{
Description: A value indicating whether it has licensed plans ,
Required: True ,
}
boolean ,
isFree:
{
Description: A value indicating whether it has at least one free availability in any market ,
Required: True ,
}
boolean ,
isPayg:
{
Description: A value indicating whether the plan is 'Pay As You Go' ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether it has been stopped from sell in a market ,
Required: True ,
}
boolean ,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
cspState:
{
Description: A value indicating whether the product is available for purchase through CSP channel ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource Provider Namespace ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Provider type ,
Required: False ,
}
string ,
minQuantity:
{
Description: Min quantity ,
Format: int32 ,
Required: False ,
}
integer ,
maxQuantity:
{
Description: Max quantity ,
Format: int32 ,
Required: False ,
}
integer ,
isQuantifiable:
{
Description: A value indicating whether the plan is quantifiable ,
Required: True ,
}
boolean ,
callToAction:
{
Description: Ahe action that can be performed on this plan on the storefronts ,
Required: False ,
}
string ,
redirectUrl:
{
Description: URL to redirect the user to post the performed action on the storefronts ,
Required: False ,
}
string ,
serviceIdentifier:
{
Description: Service identifier ,
Required: False ,
}
string ,
vmSecurityType:
{
Description: VM security type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Required: False ,
}
string ,
}
,
]
,
resourceGroupName:
{
Description: Resource group name the gallery item belongs to ,
Required: False ,
}
string ,
definitionTemplates:
{
Description: Definition templates ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Properties provided for the item ,
Required: False ,
}
object ,
restrictedAudience:
{
Description: This fields supports setting explicit audience like subscription, tenant or user ,
Required: False ,
}
string ,
isThirdParty:
{
Description: A value indicating whether the product is third party offer or not ,
Required: True ,
}
boolean ,
groupId:
{
Description: This value is used to merge different entities to a single item ,
Required: False ,
}
string ,
hideKeys:
{
Description: List of hide keys provided for the item ,
Required: False ,
}
[
string ,
]
,
keywords:
{
Description: List of keywords provided for the item ,
Required: False ,
}
[
string ,
]
,
popularity:
{
Description: Popularity of the product ,
Format: double ,
Required: True ,
}
number ,
pricingDetailsUri:
{
Description: Pricing details uri of the product ,
Required: False ,
}
string ,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
isByol:
{
Description: A value indicating whether it has licensed plans ,
Required: True ,
}
boolean ,
isMacc:
{
Description: A value indicating whether it is MACC eligible ,
Required: True ,
}
boolean ,
hasFreePlans:
{
Description: A value indicating whether it has free plans ,
Required: True ,
}
boolean ,
isQuantifiable:
{
Description: A value indicating whether product is quantifiable ,
Required: True ,
}
boolean ,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
hasPaygPlans:
{
Description: A value indicating whether an offer has a 'Pay As You Go' plan ,
Required: True ,
}
boolean ,
isReseller:
{
Description: A value indicating whether microsoft is acting as a reseller ,
Required: True ,
}
boolean ,
ttl:
{
Description: Expiration policy in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
isExcludedFromSearch:
{
Description: A value indicating whether the offer should excluded from search ,
Required: True ,
}
boolean ,
applicableStoreFronts:
{
Description: A value indicating what store fronts this offer should surface on ,
Required: False ,
}
string ,
offerVersion:
{
Description: Offer version specified by the publisher on publishing portal ,
Required: False ,
}
string ,
isMicrosoftProduct:
{
Description: A value indicating whether it is a microsoft product ,
Required: False ,
}
boolean ,
productOwnershipSellingMotion:
{
Description: Product ownership selling motion ,
Required: False ,
}
string ,
documentLinks:
{
Description: The list of document links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: URI of the link ,
Required: False ,
}
string ,
}
,
]
,
offerEnvironment:
{
Description: A value indicating offer's environment ,
Required: True ,
}
string ,
linkedAddIns:
{
Description: List of linked Add Ins provided for the item ,
Required: False ,
}
[
string ,
]
,
excludeFromBootstrap:
{
Description: A value indicating whether the offer should not be re-ingest during bootstrap session ,
Required: True ,
}
boolean ,
hydrationNotificationReceivedAt:
{
Description: Notification creation time ,
Format: date-time ,
Required: False ,
}
string ,
bigCatLastModifiedDate:
{
Description: Last modified date ,
Format: date-time ,
Required: False ,
}
string ,
disableSendEmailOnPurchase:
{
Description: Indication to disable sending email on purchase ,
Required: True ,
}
boolean ,
hideFromSaasBlade:
{
Description: Indication to hide from SaaS blade ,
Required: True ,
}
boolean ,
integratedWithMicrosoftGraphApi:
{
Description: Indication if there is integrated with Microsoft graph API ,
Required: True ,
}
boolean ,
multiTenantAadAppId:
{
Description: Multi tenant AAD app id ,
Required: False ,
}
string ,
licenseManagementType:
{
Description: License management type ,
Required: False ,
}
string ,
licenseModel:
{
Description: License model ,
Required: False ,
}
string ,
pbiServicePrincipalIds:
{
Description: PBI service principals ,
Required: False ,
}
[
string ,
]
,
isCoreVm:
{
Description: Set to true only for offers of OfferType.VirtualMachine to indicate that it was originally of OfferType.CoreVirtualMachine ,
Required: False ,
}
boolean ,
m365CertificationInfo:
{
Description: M365 Certification info ,
Required: False ,
}
string ,
downloadLink:
{
Description: Download link for offers of type OfferType.PowerBIVisuals ,
Required: False ,
}
string ,
downloadSampleLink:
{
Description: Download sample report link for offers of type OfferType.PowerBIVisuals ,
Required: False ,
}
string ,
omexAssetId:
{
Description: Asset ID for offers of type OfferType.PowerBIVisuals ,
Required: False ,
}
string ,
mixProductId:
{
Description: Product ID for offers of type OfferType.PowerBIVisuals ,
Required: False ,
}
string ,
appFreeType:
{
Description: Whether an offer has additional purchases required ,
Required: False ,
}
string ,
storeFrontPricings:
{
Description: storefront pricings parameters for AppSource and AMP ,
Required: False ,
}
object ,
}

⚐ Response (404)

{
$schema: string ,
}
PublicOffers_List (new)
Description :  Get a list of public available offers
Reference :  Link ¶

⚼ Request

GET:  /offers
{
api-version:
{
Description: API version ,
Required: True ,
}
string ,
language:
{
Description: Offer language ,
Required: False ,
}
string ,
hideKeys:
{
Description: Add hide key to retrieve preview items ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
items:
{
Description: Gets the collection of entities for this feed. ,
Required: False ,
}
[
{
language:
{
Description: Language ,
Required: True ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
hasStandardContractAmendments:
{
Description: A value indicating whether standard contract amendments are present for this product ,
Required: True ,
}
boolean ,
publisherMpnId:
{
Description: The publisher's Microsoft Partner Network (MPN) Id ,
Required: False ,
}
string ,
sellerId:
{
Description: Partner Center Seller Id ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
partnerCenterId:
{
Description: Partner center id ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
offerId:
{
Description: Offer id ,
Required: True ,
}
string ,
legacyId:
{
Description: Offer legacy id ,
Required: True ,
}
string ,
determinedStorefronts:
{
Description: The list of the storefronts for which this offer is designated ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: Summary ,
Required: False ,
}
string ,
longSummary:
{
Description: Long summary ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
offerType:
{
Description: Offer type ,
Required: True ,
}
string ,
isPrivate:
{
Description: A value indicating whether the item is private ,
Required: True ,
}
boolean ,
isPreview:
{
Description: A value indicating whether the item is preview ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether sale of this item is stopped ,
Required: True ,
}
boolean ,
fulfillBeforeChargeEligible:
{
Description: A value indicating whether this item is eligible for fulfill before charge ,
Required: True ,
}
boolean ,
marketingMaterial:
{
Description: Marketing material added by the publisher ,
Required: False ,
}
string ,
markets:
{
Description: Markets for the item ,
Required: False ,
}
[
string ,
]
,
isvContactDetails:
{
Description: ISV contact details ,
Required: False ,
}
object ,
bigId:
{
Description: Big catalog id ,
Required: True ,
}
string ,
ocpSolutionId:
{
Description: OCP solution id of the product ,
Required: False ,
}
string ,
legalTermsUri:
{
Description: Legal terms URI ,
Required: False ,
}
string ,
cspLegalTermsUri:
{
Description: CSP legal terms URI ,
Required: False ,
}
string ,
legalTermsType:
{
Description: Type of to the legal terms ,
Required: True ,
}
string ,
privacyPolicyUri:
{
Description: Uri to the privacy policy of the product ,
Required: False ,
}
string ,
helpLink:
{
Description: Help link for the product ,
Required: False ,
}
string ,
supportUri:
{
Description: Support uri of the product ,
Required: False ,
}
string ,
version:
{
Description: Big Cat submission version ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: User interface definition uri ,
Required: False ,
}
string ,
categoryIds:
{
Description: List of category IDs the marketplace item belongs to ,
Required: False ,
}
[
string ,
]
,
marketCode:
{
Description: Market code of a service offer ,
Required: False ,
}
string ,
marketStates:
{
Description: Market states of a service offer ,
Required: False ,
}
[
string ,
]
,
industryIds:
{
Description: List of industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
cloudIndustryCategories:
{
Description: List of cloud industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
primaryProduct:
{
Description: Primary product for the offer ,
Required: False ,
}
string ,
supportedProducts:
{
Description: It maps to the list of products the publisher provides with which their offer works ,
Required: False ,
}
[
string ,
]
,
applicableProducts:
{
Description: Product categories the offer belongs to ,
Required: False ,
}
[
string ,
]
,
serviceType:
{
Description: Service type that applies to the offer ,
Required: False ,
}
string ,
competencies:
{
Description: Competencies that apply to the offer ,
Required: False ,
}
[
{
competencyName:
{
Description: Competency name ,
Required: False ,
}
string ,
competencyLevel:
{
Description: Competency level ,
Required: False ,
}
string ,
}
,
]
,
hasPrices:
{
Description: A value indicating whether the item has prices ,
Required: False ,
}
boolean ,
duration:
{
Description: The duration that applies to the item ,
Required: False ,
}
string ,
marketPricingDetails:
{
Description: The pricing details of each market to the item ,
Required: False ,
}
[
{
pricing:
{
Description: Pricing that applies to the item ,
Required: False ,
}
string ,
marketCode:
{
Description: Market code of a service offer ,
Required: False ,
}
string ,
marketStates:
{
Description: Market states of a service offer ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
pricing:
{
Description: The pricing that applies to the item ,
Required: False ,
}
string ,
solutionAreas:
{
Description: The states that apply to the item ,
Required: False ,
}
[
string ,
]
,
screenshotUris:
{
Description: List of screenshot image URIs provided for the item ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: List of Links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: URI of the link ,
Required: False ,
}
string ,
}
,
]
,
filters:
{
Description: List of filters for the item ,
Required: False ,
}
[
{
type:
{
Description: Filter type ,
Required: False ,
}
string ,
value:
{
Description: Filter value ,
Required: False ,
}
string ,
}
,
]
,
iconFileUris:
{
Description: Dictionary of icon image URIs by icon type ,
Required: False ,
}
object ,
artifacts:
{
Description: List of artifacts ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
type:
{
Description: Artifact type ,
Required: True ,
}
string ,
}
,
]
,
metadata:
{
Description: Custom item metadata ,
Required: False ,
}
string ,
images:
{
Description: List of Images ,
Required: False ,
}
[
{
context:
{
Description: context ,
Required: False ,
}
string ,
items:
{
Description: List of images ,
Required: False ,
}
[
{
id:
{
Description: Image id ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
type:
{
Description: Image type ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
videos:
{
Description: List of product videos ,
Required: False ,
}
[
{
caption:
{
Description: Caption ,
Required: False ,
}
string ,
uri:
{
Description: Video uri ,
Format: uri ,
Required: False ,
}
string ,
videoPurpose:
{
Description: Video purpose ,
Required: False ,
}
string ,
previewImage:
{
Description: Preview image ,
Required: False ,
}
string ,
}
,
]
,
plans:
{
Description: Plans available for the offer details ,
Required: False ,
}
[
{
id:
{
Description: Plan id ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan ,
Required: False ,
}
string ,
summary:
{
Description: Summary of the plan ,
Required: False ,
}
string ,
description:
{
Description: Description of the plan ,
Required: False ,
}
string ,
restrictedAudience:
{
Description: Restricted audience ,
Required: False ,
}
string ,
skuId:
{
Description: Sku id ,
Required: False ,
}
string ,
planId:
{
Description: Plan id ,
Required: False ,
}
string ,
legacyPlanId:
{
Description: Legacy plan Id which is obtained by combining Offer->LegacyId and PlanId with no separator in between ,
Required: False ,
}
string ,
keywords:
{
Description: List of keywords ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Offer type ,
Required: True ,
}
string ,
leadGeneration:
{
Description: Lead generation info ,
Required: False ,
}
string ,
testDrive:
{
Description: Test Drive info ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities for this plan ,
Required: False ,
}
[
{
actions:
{
Description: List of allowed actions ,
Required: False ,
}
[
string ,
]
,
market:
{
Description: Market for the availability collection ,
Required: False ,
}
string ,
isPIRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
appId:
{
Description: App id of the availability collection ,
Required: False ,
}
string ,
planID:
{
Description: Plan Id of the availability collection ,
Required: False ,
}
string ,
meterId:
{
Description: Applicable billing meter Id ,
Required: False ,
}
string ,
meter:
{
Description: Applicable billing meter information ,
Required: False ,
}
string ,
pricingAudience:
{
Description: Pricing audience ,
Required: True ,
}
string ,
terms:
{
Description: List of applicable terms ,
Required: False ,
}
[
{
termDescriptionParameters:
{
Description: Term description parameters ,
Required: False ,
}
[
{
parameter:
{
Description: Parameter ,
Required: False ,
}
string ,
value:
{
Description: Value ,
Required: False ,
}
string ,
}
,
]
,
termId:
{
Description: Term id ,
Required: False ,
}
string ,
termUnits:
{
Description: Term unit ,
Required: False ,
}
string ,
prorationPolicy:
{
Description: Proration policy ,
Required: False ,
}
string ,
termDescription:
{
Description: Term description ,
Required: False ,
}
string ,
price:
{
Description: Price for the term ,
Required: False ,
}
string ,
renewTermId:
{
Description: Renew term id ,
Required: False ,
}
string ,
renewTermUnits:
{
Description: Renew term units ,
Required: False ,
}
string ,
billingPlan:
{
Description: Billing Plan ,
Required: False ,
}
string ,
}
,
]
,
piFilter:
{
Description: Applicable billing meter information ,
Required: False ,
}
string ,
isStopSell:
{
Description: A value indicating whether it has been stopped from sell in a market ,
Required: True ,
}
boolean ,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
assetBehaviors:
{
Description: Asset behaviors ,
Required: False ,
}
[
string ,
]
,
consumptionUnitType:
{
Description: Consumption unit type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Format: int32 ,
Required: True ,
}
integer ,
partitionKey:
{
Description: Partition key ,
Required: False ,
}
string ,
remediationRequired:
{
Description: A value indicating whether remediation is required to acquire availability ,
Required: True ,
}
boolean ,
remediations:
{
Description: Remediation actions for acquiring availability if RemediationRequired is true ,
Required: False ,
}
[
{
remediationId:
{
Description: Remediation identifier ,
Required: False ,
}
string ,
type:
{
Description: Remediation type ,
Required: False ,
}
string ,
}
,
]
,
startDate:
{
Description: Availability effectiveness start date - in epoch minutes ,
Format: int32 ,
Required: False ,
}
integer ,
endDate:
{
Description: Availability effectiveness end date - in epoch minutes ,
Format: int32 ,
Required: False ,
}
integer ,
planAvailabilities:
{
Description: Plan availabilities ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
categoryIds:
{
Description: Category IDs for this plan ,
Required: False ,
}
[
string ,
]
,
conversionPaths:
{
Description: Conversion paths for this plan ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata for this plan ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Operating system info for this plan ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: What blade to be opened when someone wants to create the marketplace item ,
Required: False ,
}
string ,
artifacts:
{
Description: Files related to the marketplace item ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
type:
{
Description: Artifact type ,
Required: True ,
}
string ,
}
,
]
,
version:
{
Description: Version of the marketplace item ,
Required: False ,
}
string ,
itemName:
{
Description: Item name ,
Required: False ,
}
string ,
isPrivate:
{
Description: A value indicating whether the item is private ,
Required: True ,
}
boolean ,
isHidden:
{
Description: A value indicating whether the plan is hidden ,
Required: True ,
}
boolean ,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
isByol:
{
Description: A value indicating whether it has licensed plans ,
Required: True ,
}
boolean ,
isFree:
{
Description: A value indicating whether it has at least one free availability in any market ,
Required: True ,
}
boolean ,
isPayg:
{
Description: A value indicating whether the plan is 'Pay As You Go' ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether it has been stopped from sell in a market ,
Required: True ,
}
boolean ,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
cspState:
{
Description: A value indicating whether the product is available for purchase through CSP channel ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: Resource Provider Namespace ,
Required: False ,
}
string ,
resourceType:
{
Description: Resource Provider type ,
Required: False ,
}
string ,
minQuantity:
{
Description: Min quantity ,
Format: int32 ,
Required: False ,
}
integer ,
maxQuantity:
{
Description: Max quantity ,
Format: int32 ,
Required: False ,
}
integer ,
isQuantifiable:
{
Description: A value indicating whether the plan is quantifiable ,
Required: True ,
}
boolean ,
callToAction:
{
Description: Ahe action that can be performed on this plan on the storefronts ,
Required: False ,
}
string ,
redirectUrl:
{
Description: URL to redirect the user to post the performed action on the storefronts ,
Required: False ,
}
string ,
serviceIdentifier:
{
Description: Service identifier ,
Required: False ,
}
string ,
vmSecurityType:
{
Description: VM security type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Required: False ,
}
string ,
}
,
]
,
resourceGroupName:
{
Description: Resource group name the gallery item belongs to ,
Required: False ,
}
string ,
definitionTemplates:
{
Description: Definition templates ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Properties provided for the item ,
Required: False ,
}
object ,
restrictedAudience:
{
Description: This fields supports setting explicit audience like subscription, tenant or user ,
Required: False ,
}
string ,
isThirdParty:
{
Description: A value indicating whether the product is third party offer or not ,
Required: True ,
}
boolean ,
groupId:
{
Description: This value is used to merge different entities to a single item ,
Required: False ,
}
string ,
hideKeys:
{
Description: List of hide keys provided for the item ,
Required: False ,
}
[
string ,
]
,
keywords:
{
Description: List of keywords provided for the item ,
Required: False ,
}
[
string ,
]
,
popularity:
{
Description: Popularity of the product ,
Format: double ,
Required: True ,
}
number ,
pricingDetailsUri:
{
Description: Pricing details uri of the product ,
Required: False ,
}
string ,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
isByol:
{
Description: A value indicating whether it has licensed plans ,
Required: True ,
}
boolean ,
isMacc:
{
Description: A value indicating whether it is MACC eligible ,
Required: True ,
}
boolean ,
hasFreePlans:
{
Description: A value indicating whether it has free plans ,
Required: True ,
}
boolean ,
isQuantifiable:
{
Description: A value indicating whether product is quantifiable ,
Required: True ,
}
boolean ,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
hasPaygPlans:
{
Description: A value indicating whether an offer has a 'Pay As You Go' plan ,
Required: True ,
}
boolean ,
isReseller:
{
Description: A value indicating whether microsoft is acting as a reseller ,
Required: True ,
}
boolean ,
ttl:
{
Description: Expiration policy in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
isExcludedFromSearch:
{
Description: A value indicating whether the offer should excluded from search ,
Required: True ,
}
boolean ,
applicableStoreFronts:
{
Description: A value indicating what store fronts this offer should surface on ,
Required: False ,
}
string ,
offerVersion:
{
Description: Offer version specified by the publisher on publishing portal ,
Required: False ,
}
string ,
isMicrosoftProduct:
{
Description: A value indicating whether it is a microsoft product ,
Required: False ,
}
boolean ,
productOwnershipSellingMotion:
{
Description: Product ownership selling motion ,
Required: False ,
}
string ,
documentLinks:
{
Description: The list of document links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: URI of the link ,
Required: False ,
}
string ,
}
,
]
,
offerEnvironment:
{
Description: A value indicating offer's environment ,
Required: True ,
}
string ,
linkedAddIns:
{
Description: List of linked Add Ins provided for the item ,
Required: False ,
}
[
string ,
]
,
excludeFromBootstrap:
{
Description: A value indicating whether the offer should not be re-ingest during bootstrap session ,
Required: True ,
}
boolean ,
hydrationNotificationReceivedAt:
{
Description: Notification creation time ,
Format: date-time ,
Required: False ,
}
string ,
bigCatLastModifiedDate:
{
Description: Last modified date ,
Format: date-time ,
Required: False ,
}
string ,
disableSendEmailOnPurchase:
{
Description: Indication to disable sending email on purchase ,
Required: True ,
}
boolean ,
hideFromSaasBlade:
{
Description: Indication to hide from SaaS blade ,
Required: True ,
}
boolean ,
integratedWithMicrosoftGraphApi:
{
Description: Indication if there is integrated with Microsoft graph API ,
Required: True ,
}
boolean ,
multiTenantAadAppId:
{
Description: Multi tenant AAD app id ,
Required: False ,
}
string ,
licenseManagementType:
{
Description: License management type ,
Required: False ,
}
string ,
licenseModel:
{
Description: License model ,
Required: False ,
}
string ,
pbiServicePrincipalIds:
{
Description: PBI service principals ,
Required: False ,
}
[
string ,
]
,
isCoreVm:
{
Description: Set to true only for offers of OfferType.VirtualMachine to indicate that it was originally of OfferType.CoreVirtualMachine ,
Required: False ,
}
boolean ,
m365CertificationInfo:
{
Description: M365 Certification info ,
Required: False ,
}
string ,
downloadLink:
{
Description: Download link for offers of type OfferType.PowerBIVisuals ,
Required: False ,
}
string ,
downloadSampleLink:
{
Description: Download sample report link for offers of type OfferType.PowerBIVisuals ,
Required: False ,
}
string ,
omexAssetId:
{
Description: Asset ID for offers of type OfferType.PowerBIVisuals ,
Required: False ,
}
string ,
mixProductId:
{
Description: Product ID for offers of type OfferType.PowerBIVisuals ,
Required: False ,
}
string ,
appFreeType:
{
Description: Whether an offer has additional purchases required ,
Required: False ,
}
string ,
storeFrontPricings:
{
Description: storefront pricings parameters for AppSource and AMP ,
Required: False ,
}
object ,
}
,
]
,
nextPageLink:
{
Description: Gets the link for the next page of items in the feed. ,
Format: uri ,
Required: False ,
}
string ,
count:
{
Description: Gets the total count of items in the feed. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (400)

{
$schema: string ,
}